home *** CD-ROM | disk | FTP | other *** search
/ Deutsche Edition 1 / Deutsche Edition 1.iso / amok / 071-080 / amok71 / xstat / xstat.doc < prev    next >
Text File  |  1993-11-04  |  10KB  |  382 lines
  1. XStat V1.03 Documentation
  2. =========================
  3.  
  4. IMPORT StdDisclaimer; (* in short: use it at your own risk *)
  5. XStat was carefully tested, but there's certainly plenty of room for bugs.
  6.  
  7. XStat V1.03 is Freeware, non-commercial distribution is o.k. as long as
  8. the following conditions are satisfied:
  9.  
  10.   * Source, executables and documentation must be distributed together
  11.     (XStat.mod, XStat, XStatFPU, XStat.data, XStat.doc, XStat.dok and Make),
  12.     and these files must be intact (you're not allowed to make changes).
  13.  
  14.   * Disk librarians: you may charge no more than the current price
  15.     of a single AmigaLibDisk from Fred Fish
  16.  
  17.  
  18.  
  19. XStat requires AmigaOS V36 or later.
  20.  
  21.  
  22.  
  23. Purpose
  24. =======
  25. XStat extracts statistic information from the Xferstat file created
  26. by Andrew "Charly" Kopp's UUCiCo V1.15c (or later). The most important
  27. information XStat gives to you is the phone cost for a certain number
  28. of connects.
  29.  
  30.  
  31.  
  32. Installation
  33. ============
  34. The distribution includes two executables,
  35.   * XStat       (standard version)
  36.   * XStatFPU    (680(2|3)0 + 6888(1|2) required)
  37. Copy one of these to a dircetory in your "Path", preferably UUBIN:
  38.  
  39. There's only one more file that needs to be installed; it's called
  40. "XStat.data", and should be copied to your UULIB: directory.
  41.  
  42. You'll have to edit XStat.data to complete the installation.
  43.  
  44.  
  45.  
  46. XStat.data
  47. ==========
  48. XStat.data contains the phone cost on a "per host" basis, in the following
  49. format:
  50.  
  51. XStat.data file header:
  52. -----------------------
  53. H XSTAT DATA
  54.  
  55. This header must be the first line of XStat.data
  56.  
  57. XStat.data comment line:
  58. ------------------------
  59.  
  60. # any comments you wish to add to XStat.data
  61.  
  62. You may add comment lines anywhere in your XStat.data file, except before
  63. the file header.
  64.  
  65. XStat.data currency sign info:
  66. ------------------------------
  67. S <currency sign>
  68.  
  69. Tells XStat the currency sign for your country. This line must come before
  70. the first "N"-line. There can be only one "S"-line in your XStat.data file.
  71.  
  72. Examples:
  73.  
  74. # currency sign for the U.S.A.
  75. S $
  76.  
  77. # currency sign for Germany
  78. S DM
  79.  
  80. XStat.data host name info:
  81. --------------------------
  82. N <host name>
  83.  
  84. Starts a new connection cost data record. Must be followed by at least
  85. one "C"-line. <host name> should be the name of a host you're directly
  86. connected to, without any path or domain information.
  87.  
  88. Examples:
  89.  
  90. # my own newsfeed
  91. N imart
  92.  
  93. # my alternate newsfeed
  94. N cbmger
  95.  
  96. XStat.data connection time/cost info:
  97. -------------------------------------
  98. C <start time> <duration> <price>
  99.  
  100. Tells XStat that between <start time> and <start time of next C-line>
  101. a connection will cost <price> per <duration>. "C"-lines must follow
  102. a "N"-line. <duration> must be in seconds, <price> in the currency of
  103. your choice.
  104.  
  105. The first "C"-line must be for "SU-00:00:00"!
  106.  
  107. Example:
  108. N imart
  109. C SU-00:00:00 120 0.23
  110. C MO-08:00:00  60 0.23
  111. C MO-18:00:00 120 0.23
  112.  
  113. From Sunday 0:00:00 to Monday 7:59:59, a connection between my
  114. site and my newsfeed "imart" will cost 0.23DM/120sec.
  115.  
  116. Between Monday 8:00:00 and Monday 17:59:59, a connection between my site
  117. and my newsfeed "imart" will cost 0.23DM/60sec.
  118.  
  119. With this short example, the connection cost for the rest of the
  120. week (from Monday 18:00:00 to Saturday 23:59:59) would be 0.23DM/120sec.
  121.  
  122. Full length example for XStat.data:
  123. -----------------------------------
  124.  
  125. - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut -
  126. H XSTAT DATA
  127. #==============================================================================
  128. # XStat connection cost data file
  129. #==============================================================================
  130. #
  131. #------------------------------------------------------------------------------
  132. # currency sign for Germany; S must come before first N
  133. #------------------------------------------------------------------------------
  134. S DM
  135. #
  136. #------------------------------------------------------------------------------
  137. # my own newsfeed, connection cost is 0.23/60sec (0.23/120sec night & weekend)
  138. #------------------------------------------------------------------------------
  139. N imart
  140. C SU-00:00:00 120 0.23
  141. C MO-08:00:00  60 0.23
  142. C MO-18:00:00 120 0.23
  143. C TU-08:00:00  60 0.23
  144. C TU-18:00:00 120 0.23
  145. C WE-08:00:00  60 0.23
  146. C WE-18:00:00 120 0.23
  147. C TH-08:00:00  60 0.23
  148. C TH-18:00:00 120 0.23
  149. C FR-08:00:00  60 0.23
  150. C FR-18:00:00 120 0.23
  151. #
  152. #------------------------------------------------------------------------------
  153. # cbmger, connection cost is 0.23/21sec (0.23/42sec night & weekend)
  154. #------------------------------------------------------------------------------
  155. N cbmger
  156. C SU-00:00:00  42 0.23
  157. C MO-08:00:00  21 0.23
  158. C MO-18:00:00  42 0.23
  159. C TU-08:00:00  21 0.23
  160. C TU-18:00:00  42 0.23
  161. C WE-08:00:00  21 0.23
  162. C WE-18:00:00  42 0.23
  163. C TH-08:00:00  21 0.23
  164. C TH-18:00:00  42 0.23
  165. C FR-08:00:00  21 0.23
  166. C FR-18:00:00  42 0.23
  167. #
  168. - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut - cut -
  169.  
  170.  
  171.  
  172. Usage
  173. =====
  174. XStat [?|-?|-h] [-dname] [-sname] [-v] [-fdate] [-tdate] [-i] [-o] [-nname]
  175.  
  176. You may also use the environment variable "XSTATARGS" to specify
  177. parameters. This is very useful if you're using XStat from the
  178. Workbench (XStat doesn't really support Workbench, that's why
  179. there's no icon for it).
  180.  
  181. ? | -? | -h
  182. -----------
  183. Displays a help message.
  184.  
  185. -dname
  186. ------
  187. Tells XStat to read its connection cost data from file <name>.
  188. <name> defaults to "UULIB:XStat.data".
  189.  
  190. -sname
  191. ------
  192. Tells XStat to extract the statistic information from file <name>.
  193. <name> defaults to "UUSPOOL:XferStat".
  194.  
  195. -v
  196. --
  197. Toggles the "verbose" mode. When on, XStat displays short statistics
  198. for every connect found in the Xferstat file. Defaults to "off".
  199. Specify "-v" to turn verbose mode on.
  200.  
  201. -fdate
  202. ------
  203. Tells XStat to ignore connects before <date>. <date> defaults to "01-JAN-78".
  204. You may use any valid AmigaDOS date string, including things like
  205. "TODAY" or "YESTERDAY". XStat will add a time string of "00:00:00" internally,
  206. you may not do this yourself.
  207.  
  208. -tdate
  209. ------
  210. Tells XStat to ignore connects after <date>. <date> defaults to "TODAY".
  211. You may use any valid AmigaDOS date string, including things like
  212. "TODAY" or "YESTERDAY". XStat will add a time string of "23:59:59" internally,
  213. you may not do this yourself.
  214.  
  215.  
  216. -mdate
  217. ------
  218. Tells XStat to ignore -f and -t, and to compute the statistics for the
  219. specified month instead. The month must be given in the format "MMM-YY",
  220. without specifying the day. Example: -mAPR-92 will compute the stats for
  221. April 92. -m is inactive as default.
  222.  
  223. -i
  224. --
  225. Tells XStat to evaluate incoming calls; defaults to "on". Specify "-i"
  226. to suppress evaluation of incoming calls.
  227.  
  228. -o
  229. --
  230. Tells XStat to evaluate outgoing calls; defaults to "on". Specify "-o"
  231. to suppress evaluation of outgoing calls.
  232.  
  233. -q
  234. --
  235. Tells XStat to suppress non-fatal error messages; defaults to "off".
  236. Specify "-q" to suppress non-fatal errors.
  237.  
  238. This is very handy for getting rid of those "(ignoring this one)" messages
  239. for failed connects.
  240.  
  241. -nname
  242. ------
  243. Tells XStat to evaluate calls to host <name> only; defaults to all hosts.
  244.  
  245.  
  246.  
  247. XStat's output
  248. ==============
  249.  
  250. Example:
  251.  
  252. > XStat V1.03
  253. > © Copyright 1992 by Jürgen Weinelt
  254. > XStat is Freeware - read the docs for details.
  255. >
  256. >
  257. >
  258. >
  259. > Connection statistics for outgoing calls:
  260. > -----------------------------------------
  261. >
  262. > connects              53
  263. > online time        35421 sec      (     668 sec/connect)
  264. > units                323 units    (   6.094 units/connect)
  265. > cost               74.29 DM       (   1.402 DM/connect)
  266. >
  267. > brutto read      7493483 bytes    (  141386 bytes/connect)
  268. > brutto send       882109 bytes    (   16643 bytes/connect)
  269. > netto read       6526244 bytes    (  123136 bytes/connect)
  270. > netto send        132519 bytes    (    2500 bytes/connect)
  271. >
  272. > ø brutto speed       236 cps      (     243 cps peak)
  273. > ø netto speed        187 cps      (     200 cps peak)
  274. > ø brutto cost      9.301 DM/MB
  275. > ø netto cost      11.699 DM/MB
  276. >
  277. >
  278. >
  279. > Connection statistics for incoming calls:
  280. > -----------------------------------------
  281. >
  282. > no connects recorded.
  283.  
  284. connects
  285. --------
  286. Number of connects.
  287.  
  288. online time
  289. -----------
  290. Total online time, and average online time per connect.
  291.  
  292. units
  293. -----
  294. Phone units consumed, and average phone units consumed per connect.
  295.  
  296. Note: in Germany, a "phone unit" is an indivisible time quantum
  297. (sounds like quantum physics :-). This means, even if you're connect
  298. is shorter than that, the phone company still charges for the entire
  299. time quantum. Example: unit duration is 60 seconds, connect time was
  300. 97 seconds, phone company charges two units (120 seconds).
  301.  
  302. You can influence the unit duration by editing the XStat.data file;
  303. the <duration> in the "C"-lines tells XStat the unit duration.
  304.  
  305. cost
  306. ----
  307. Total cost, and average cost per connect.
  308.  
  309. brutto read
  310. -----------
  311. Total bytes read (including protocol information), and average (per connect).
  312.  
  313. brutto send
  314. -----------
  315. Total bytes sent (including protocol information), and average (per connect).
  316.  
  317. netto read
  318. ----------
  319. Total bytes read (excluding protocol information), and average (per connect).
  320.  
  321. netto send
  322. ----------
  323. Total bytes sent (excluding protocol information), and average (per connect).
  324.  
  325. ø brutto speed
  326. --------------
  327. Average transmission speed, including protocol overhead, and speed of
  328. fastest connect.
  329.  
  330. ø netto speed
  331. -------------
  332. Average transmission speed, excluding protocol overhead, and speed of
  333. fastest connect.
  334.  
  335. ø brutto cost
  336. -------------
  337. Average cost per MByte, including protocol overhead.
  338.  
  339. ø netto cost
  340. ------------
  341. Average cost per MByte, excluding protocol overhead.
  342.  
  343.  
  344.  
  345. History
  346. =======
  347. V1.03   added monthly statistics.
  348. V1.02   added peak brutto/netto cps rating.
  349. V1.01   XStat used to guru when brutto or netto xfer was 0 bytes. Fixed.
  350. V1.00   initial release.
  351.  
  352.  
  353.  
  354. Known problems/bugs
  355. ===================
  356. None so far...
  357.  
  358. Well, actually, there's one problem I can't do anything about... the
  359. online time is not very accurate. That's because the connection start
  360. time states the time the modem says "CONNECT", not the real start
  361. time of the (phone line) connection.
  362.  
  363.  
  364.  
  365. You can contact me through the Usenet:
  366.  
  367.    {uunet|rutgers}!cbmvax!cbmehq!cbmger!imart!hcast!jow
  368.  
  369. (Sorry, no domain yet)
  370.  
  371. Or through the snail mail:
  372.  
  373.    Jürgen Weinelt
  374.    Zur Kanzel 1
  375.    D-8783 Hammelburg
  376.    Germany
  377.  
  378. You might also try posting to comp.sys.amiga.programmer or alt.sys.amiga.uucp,
  379. I'll probably read those newsgroups.
  380.  
  381. Enjoy!
  382.